Add a note to gdk_screen_get_width/height_mm
authorMatthias Clasen <mclasen@redhat.com>
Sun, 16 Aug 2015 02:20:16 +0000 (22:20 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sun, 16 Aug 2015 02:20:16 +0000 (22:20 -0400)
The values returned by these functions are not very well defined,
recommend to use the monitor dimensions instead.

gdk/gdkscreen.c

index 146e5af192b23a758cd799c215a5fe0c2ba7d510..494902251c15640411f7467d82d92f53226fecb2 100644 (file)
@@ -619,7 +619,10 @@ gdk_screen_get_height (GdkScreen *screen)
  * @screen: a #GdkScreen
  *
  * Gets the width of @screen in millimeters.
- * Note that on some X servers this value will not be correct.
+ *
+ * Note that this value is somewhat ill-defined when the screen
+ * has multiple monitors of different resolution. It is recommended
+ * to use the monitor dimensions instead.
  *
  * Returns: the width of @screen in millimeters.
  *
@@ -638,7 +641,10 @@ gdk_screen_get_width_mm (GdkScreen *screen)
  * @screen: a #GdkScreen
  *
  * Returns the height of @screen in millimeters.
- * Note that on some X servers this value will not be correct.
+ *
+ * Note that this value is somewhat ill-defined when the screen
+ * has multiple monitors of different resolution. It is recommended
+ * to use the monitor dimensions instead.
  *
  * Returns: the heigth of @screen in millimeters.
  *